<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
    <head>
        <title>Rename Suffix Formatter Options</title>
    </head>
    <body>
    <h3>Rename Suffix Formatter Options</h3>
    <p>
        <h4>Suffix Formatter</h4>
        <p>
        FileCopier uses the last modified date of a file to build a suffix at the end of the file name when
        renaming it. You can select the format to use. The format can be set to show the last modified date/time
        in a format of your choosing, or you can set it to a constant such as "old". If you want to set the format
        to show the date, it must be a valid format. A description of valid date formats which are taken from Sun's
        javadoc for <a href="http://java.sun.com/javase/6/docs/api/java/util/Formatter.html">Formatter</a> can be
        found below.<br> 
        
        <h4>Format String Syntax</h4>
        <p>
        Format strings may contain fixed text and one or more embedded <i>format specifiers</i>. The most basic of
        these is '%'.

         <p> The format specifiers for types which are used to represent dates and
         times have the following syntax:

         <blockquote><pre>

           %[flags][width]conversion
         </pre></blockquote>
        
         <p> The optional <i>flags</i> is a set of characters that modify the output
         format.  The set of valid flags depends on the conversion.

         <p> The optional <i>width</i> is a non-negative decimal integer indicating
         the minimum number of characters to be written to the output.

         <p> The required <i>conversion</i> is a two character sequence.  The first
         character is <tt>'t'</tt> or <tt>'T'</tt>.  The second character indicates
         the format to be used.  These characters are similar to but not completely
         identical to those defined by GNU <tt>date</tt> and POSIX
         <tt>strftime(3c)</tt>.
         
         <h4> Date/Time Conversions </h4>

         <p> The following date and time conversion suffix characters are defined for
         the <tt>'t'</tt> and <tt>'T'</tt> conversions.  The types are similar to but
         not completely identical to those defined by GNU <tt>date</tt> and POSIX
         <tt>strftime(3c)</tt>.  Additional conversion types are provided to access
         Java-specific functionality (e.g. <tt>'L'</tt> for milliseconds within the
         second).

         <h4>The following conversion characters are used for formatting times:</h4>

         <table cellpadding=5 summary="time">

         <tr><td valign="top"> <tt>H</tt>
             <td> Hour of the day for the 24-hour clock, formatted as two digits with
             a leading zero as necessary i.e. <tt>00 - 23</tt>.

         <tr><td valign="top"><tt>I</tt>
             <td> Hour for the 12-hour clock, formatted as two digits with a leading
             zero as necessary, i.e.  <tt>01 - 12</tt>.

         <tr><td valign="top"><tt>k</tt>

             <td> Hour of the day for the 24-hour clock, i.e. <tt>0 - 23</tt>.

         <tr><td valign="top"><tt>l</tt>
             <td> Hour for the 12-hour clock, i.e. <tt>1 - 12</tt>.

         <tr><td valign="top"><tt>M</tt>
             <td> Minute within the hour formatted as two digits with a leading zero
             as necessary, i.e.  <tt>00 - 59</tt>.

         <tr><td valign="top"><tt>S</tt>

             <td> Seconds within the minute, formatted as two digits with a leading
             zero as necessary, i.e. <tt>00 - 60</tt> ("<tt>60</tt>" is a special
             value required to support leap seconds).

         <tr><td valign="top"><tt>L</tt>
             <td> Millisecond within the second formatted as three digits with
             leading zeros as necessary, i.e. <tt>000 - 999</tt>.

         <tr><td valign="top"><tt>N</tt>

             <td> Nanosecond within the second, formatted as nine digits with leading
             zeros as necessary, i.e. <tt>000000000 - 999999999</tt>.

         <tr><td valign="top"><tt>p</tt>
             <td> Locale-specific morning or afternoon marker
             in lower case, e.g."<tt>am</tt>" or "<tt>pm</tt>". Use of the conversion
             prefix <tt>'T'</tt> forces this output to upper case.

         <tr><td valign="top"><tt>z</tt>

             <td> RFC&nbsp;822
             style numeric time zone offset from GMT, e.g. <tt>-0800</tt>.

         <tr><td valign="top"><tt>Z</tt>
             <td> A string representing the abbreviation for the time zone.  The
             Formatter's locale will supersede the locale of the argument (if any).

         <tr><td valign="top"><tt>s</tt>
             <td> Seconds since the beginning of the epoch starting at 1 January 1970
             <tt>00:00:00</tt> UTC, i.e. <tt>Long.MIN_VALUE/1000</tt> to
             <tt>Long.MAX_VALUE/1000</tt>.

         <tr><td valign="top"><tt>Q</tt>

             <td> Milliseconds since the beginning of the epoch starting at 1 January
             1970 <tt>00:00:00</tt> UTC, i.e. <tt>Long.MIN_VALUE</tt> to
             <tt>Long.MAX_VALUE</tt>.

         </table>

         <h4>The following conversion characters are used for formatting dates:</h4>

         <table cellpadding=5 summary="date">

         <tr><td valign="top"><tt>B</tt>
             <td> Locale-specific full month name, e.g. <tt>"January"</tt>, <tt>"February"</tt>.

         <tr><td valign="top"><tt>b</tt>
             <td> Locale-specific abbreviated month name,
             e.g. <tt>"Jan"</tt>, <tt>"Feb"</tt>.

         <tr><td valign="top"><tt>h</tt>

             <td> Same as <tt>'b'</tt>.

         <tr><td valign="top"><tt>A</tt>
             <td> Locale-specific full name of the day of the week,
             e.g. <tt>"Sunday"</tt>, <tt>"Monday"</tt>

         <tr><td valign="top"><tt>a</tt>
             <td> Locale-specific short name of the day of the week,
             e.g. <tt>"Sun"</tt>, <tt>"Mon"</tt>

         <tr><td valign="top"><tt>C</tt>
             <td> Four-digit year divided by <tt>100</tt>, formatted as two digits
             with leading zero as necessary, i.e. <tt>00 - 99</tt>

         <tr><td valign="top"><tt>Y</tt>
             <td> Year, formatted as at least four digits with leading zeros as
             necessary, e.g. <tt>0092</tt> equals <tt>92</tt> CE for the Gregorian
             calendar.

         <tr><td valign="top"><tt>y</tt>
             <td> Last two digits of the year, formatted with leading zeros as
             necessary, i.e. <tt>00 - 99</tt>.

         <tr><td valign="top"><tt>j</tt>

             <td> Day of year, formatted as three digits with leading zeros as
             necessary, e.g. <tt>001 - 366</tt> for the Gregorian calendar.

         <tr><td valign="top"><tt>m</tt>
             <td> Month, formatted as two digits with leading zeros as necessary,
             i.e. <tt>01 - 13</tt>.

         <tr><td valign="top"><tt>d</tt>
             <td> Day of month, formatted as two digits with leading zeros as
             necessary, i.e. <tt>01 - 31</tt>

         <tr><td valign="top"><tt>e</tt>
             <td> Day of month, formatted as two digits, i.e. <tt>1 - 31</tt>.

         </table>

         <h4> The following conversion characters are used for formatting common
         date/time compositions.</h4>

         <table cellpadding=5 summary="composites">

         <tr><td valign="top"><tt>R</tt>

             <td> Time formatted for the 24-hour clock as <tt>"%tH:%tM"</tt>

         <tr><td valign="top"><tt>T</tt>
             <td> Time formatted for the 24-hour clock as <tt>"%tH:%tM:%tS"</tt>.

         <tr><td valign="top"><tt>r</tt>
             <td> Time formatted for the 12-hour clock as <tt>"%tI:%tM:%tS %Tp"</tt>.
             The location of the morning or afternoon marker (<tt>'%Tp'</tt>) may be
             locale-dependent.

         <tr><td valign="top"><tt>D</tt>

             <td> Date formatted as <tt>"%tm/%td/%ty"</tt>.

         <tr><td valign="top"><tt>F</tt>
             <td> Complete date formatted as <tt>"%tY-%tm-%td"</tt>.

         <tr><td valign="top"><tt>c</tt>

             <td> Date and time formatted as <tt>"%ta %tb %td %tT %tZ %tY"</tt>,
             e.g. <tt>"Sun Jul 20 16:17:00 EDT 1969"</tt>.
             
         </table>
             
        <p>Remember that with FileCopier, you are formatting a date that will go on the end of a filename.
        Therefore, any format that will produce ':' characters will create an <b>invalid file name</b>, so
        don't use them. The following are some examples of good formats to use in FileCopier:<br><br>

         <p>
           "_%tY%tm%td_%tH%tM%tS%tL" e.g. "_20060805_223815231" <i>This is the default format.</i><br>
           "_%tY%tm%td_%tI%tM%tS%tL" e.g. "_20060805_103815231"<br>
           "_%tm%td%tY_%tH%tM%tS%tL" e.g. "_08052006_223815231"<br>
           "_%tm%td%tY_%tI%tM%tS%tL" e.g. "_08052006_103815231"<br>
           "_%td%tm%tY_%tH%tM%tS%tL" e.g. "_05082006_223815231"<br>
           "_%td%tm%tY_%tI%tM%tS%tL" e.g. "_05082006_103815231"<br>
           "_%tY%tm%td_%tH%tM%tS" e.g. "_20060805_223815"<br>
           "_%tY%tm%td_%tI%tM%tS" e.g. "_20060805_103815"<br>
           "_%tm%td%tY_%tH%tM%tS" e.g. "_08052006_223815"<br>
           "_%tm%td%tY_%tI%tM%tS" e.g. "_08052006_103815"<br>
           "_%td%tm%tY_%tH%tM%tS" e.g. "_05082006_223815"<br>
           "_%td%tm%tY_%tI%tM%tS" e.g. "_05082006_103815"<br><br>

         <p> Any characters not explicitly defined as date/time conversion suffixes
         are illegal and are reserved for future extensions.
         
         <p>Finally, there is a "Use GMT" check box that you can select to convert times to Greenwich Mean time.<br><br>
    </body>
</html>